メルペイ随時都度決済+利用承諾 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranMerpay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
JobCd	jobCd	必須半角英字8桁処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount	amount	必須半角数字7桁利用金額税送料を指定した場合は、利用金額 + 税送料が決済金額となります。
Tax	tax	半角数字7桁税送料
TaxCalcFlag	taxCalcFlag	半角数字1桁税送料算出方法 0：固定（デフォルト） 1：後から算出「1：後から算出」を選択した場合、ユーザが決済処理を行った際、【決済実行】の【TaxCalcURL】で指定したURLにメルペイサーバーから送信する配送先情報を元に税送料を算出する必要があります。 ※個人情報利用契約がある加盟店のみ利用できます。

URL

/payment/EntryTranMerpay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "AUTH",
  "amount": "1000"
}

URL

/payment/EntryTranMerpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranMerpay 決済実行

これ以降の都度決済+利用承諾で必要となるトークンを返却します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass		必須半角英数32桁固定取引パスワード【取引登録】で指定された値を設定します。
OrderID		必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
ItemName		商品名（※1）利用可能な文字はこちら
ItemDescription		商品説明（※1）利用可能な文字はこちら
ItemImageUrl1		半角英数記号256桁商品画像URL1（※1）
ItemImageUrl2		半角英数記号256桁商品画像URL2（※1）
ItemImageUrl3		半角英数記号256桁商品画像URL3（※1）
ItemImageUrl4		半角英数記号256桁商品画像URL4（※1）
ItemImageUrl5		半角英数記号256桁商品画像URL5（※1）
ItemImageUrl6		半角英数記号256桁商品画像URL6（※1）
ItemImageUrl7		半角英数記号256桁商品画像URL7（※1）
ItemImageUrl8		半角英数記号256桁商品画像URL8（※1）
ItemImageUrl9		半角英数記号256桁商品画像URL9（※1）
ItemCategory		全半角40桁カテゴリ名（※1）利用可能な文字はこちら
ItemSize		全半角40桁サイズ（※1）利用可能な文字はこちら
ItemBrand		全半角40桁ブランド名（※1）利用可能な文字はこちら
ItemColor		全半角40桁色（※1）利用可能な文字はこちら
ItemListPrice		半角数字7桁定価（※1）
ItemUnitPrice		半角数字7桁購入時価格（※1）
ItemQuantity		半角数字4桁購入数（※1）
ItemItemCode		全半角40桁製品管理コード（SKU）（※1）利用可能な文字はこちら
ItemJanCode		全半角13桁 JANコード（※1）利用可能な文字はこちら
ItemCategoryId		必須半角数字4桁商品カテゴリID（※1）
MultiItem		商品情報一覧複数商品の取り扱いがある場合、指定します。商品情報一覧XMLフォーマットを整形（タブや改行の除去）し、UTF-8でBase64エンコードした値を設定してください。本項目はメルペイかんたん出品連携機能で利用されます。メルペイかんたん出品連携機能をご利用する場合はかんたん出品連携機能についてをご確認ください。メルペイ側で必須になる項目があります。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
SubscriptionType		必須半角英字10桁サブスクリプションタイプ下記を設定します。 REGISTER：都度決済+利用承諾をする
SubscriptionName		必須全半角20桁サブスクリプション名称提供するサービス名を設定します。 ※メルカリアプリ上に表示されます
SubscriptionDescription		必須全半角120桁サブスクリプション説明提供するサービスの説明を設定します。 ※メルカリアプリ上に表示されます

※1：単一商品のみ取り扱いの場合、指定します。
商品情報一覧を指定した場合、本パラメータは無視されます。
本項目はメルペイかんたん出品連携機能で利用されます。
メルペイかんたん出品連携機能をご利用する場合はかんたん出品連携機能についてをご確認ください。
メルペイ側で必須になる項目があります。

URL

/payment/ExecTranMerpay.idPass

リクエストパラメータ（単一商品指定）

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&ItemCategoryId=1010&RetURL=https://example.com/receive&SubscriptionType=REGISTER&SubscriptionName=サブスクリプション名称&SubscriptionDescription=サブスクリプション説明

リクエストパラメータ（複数商品指定）

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&MultiItem=PGl0ZW1zSW5mbz48aXRlbT48Y2F0ZWdvcnlJZD4xMDEwPC9jYXRlZ29yeUlkPjwvaXRlbT48aXRlbT48Y2F0ZWdvcnlJZD4xMDExPC9jYXRlZ29yeUlkPjwvaXRlbT48L2l0ZW1zSW5mbz4=&RetURL=https://example.com/receive&SubscriptionType=REGISTER&SubscriptionName=サブスクリプション名称&SubscriptionDescription=サブスクリプション説明

[商品情報一覧XMLフォーマット]

itemsInfo	商品情報親属性
items	商品情報最大20件まで指定できます。
name	商品名
description	商品説明
imageUrl1	半角英数記号256桁商品画像URL1
imageUrl2	半角英数記号256桁商品画像URL2
imageUrl3	半角英数記号256桁商品画像URL3
imageUrl4	半角英数記号256桁商品画像URL4
imageUrl5	半角英数記号256桁商品画像URL5
imageUrl6	半角英数記号256桁商品画像URL6
imageUrl7	半角英数記号256桁商品画像URL7
imageUrl8	半角英数記号256桁商品画像URL8
imageUrl9	半角英数記号256桁商品画像URL9
category	全半角40桁カテゴリ名
size	全半角40桁サイズ
brand	全半角40桁ブランド名
color	全半角40桁色
listPrice	半角数字7桁定価
unitPrice	半角数字7桁購入時価格
quantity	半角数字4桁購入数
itemCode	全半角40桁製品管理コード（SKU）
janCode	全半角13桁 JANコード
categoryId	必須半角数字4桁商品カテゴリID

XMLヘッダは不要です。
[XMLサンプル]

idPass（複数商品指定）


<itemsInfo>
    <item>
        <name>Tシャツ</name>
        <description>テスト出品です</description>
        <imageUrl1>https://example.com/images/item1.jpg</imageUrl1>
        <category>メンズ</category>
        <size>M</size>
        <brand>テストブランド</brand>
        <color>Black</color>
        <listPrice>1200</listPrice>
        <unitPrice>1000</unitPrice>
        <quantity>1</quantity>
        <itemCode>32882558-1c19-4329-afa3-6a5a8fce8e92</itemCode>
        <janCode>1234567890123</janCode>
        <categoryId>1010</categoryId>
    </item>
    <item>
        <categoryId>1011</categoryId>
    </item>
</itemsInfo>

リクエスト

shopID		必須半角英数13桁ショップID
shopPass		必須半角英数64桁ショップパスワード
accessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
accessPass		必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
orderID		必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
deliveryAddressFlag		半角数字1桁個人情報利用フラグ 0：利用しない（デフォルト） 1：利用する「1：利用する」を選択した場合、【個人情報参照】を実行することで配送先情報を参照できるようになります。 ※個人情報利用契約がある加盟店のみ利用できます。
items		必須商品情報一覧最大20件まで指定できます。メルペイかんたん出品連携機能のご利用を検討している場合はかんたん出品連携機能についてをご確認ください。メルペイ側で必須になる項目があります。
	name	商品名利用可能な文字はこちら
	description	商品説明利用可能な文字はこちら
	imageUrls	商品画像URL一覧最大9件、1件あたり256桁まで指定できます。
	category	全半角40桁カテゴリ名利用可能な文字はこちら
	size	全半角40桁サイズ利用可能な文字はこちら
	brand	全半角40桁ブランド名利用可能な文字はこちら
	color	全半角40桁色利用可能な文字はこちら
	listPrice	半角数字7桁定価
	unitPrice	半角数字7桁購入時価格
	quantity	半角数字4桁購入数
	itemCode	全半角40桁製品管理コード利用可能な文字はこちら
	janCode	全半角13桁 JANコード利用可能な文字はこちら
	categoryId	必須半角数字4桁商品カテゴリID
httpUserAgent		ユーザーエージェントお客様端末のUserAgentを指定します。メルペイにて流入経路解析に使用されます。
clientField1		全半角100バイト加盟店自由項目1
clientField2		全半角100バイト加盟店自由項目2
clientField3		全半角100バイト加盟店自由項目3
taxCalcURL		半角英数記号256桁税送料計算URL 【取引登録】の【税送料算出方法】に【1：後から算出】を選択した場合に必須となります。 ※個人情報利用契約がある加盟店のみ利用できます。
retURL		半角英数記号256桁決済完了後の戻り先URL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。メルカリアプリ上でお客様が支払操作をキャンセルした場合や決済処理を実行した場合に、指定されたURLにブラウザのリダイレクト経由で結果が送信されます。 URLにはカスタムURLスキームの指定することができます。その際は【ユーザー端末情報】に【2：APP】を指定してください。メルカリアプリ上でお客様が支払操作をキャンセルした場合や、決済処理を実行した場合にメルカリアプリから指定されたカスタムURLスキームに遷移し結果が送信されます。当サービスからの決済結果の受信を希望しない場合は、当項目は設定しないでください。
userInfo		半角数字1桁ユーザー端末情報お客様端末の情報を指定します。 1：WEB（デフォルト） 2：APP 【1：WEB】の場合、レスポンスの【決済開始URL】に設定される当サービスのURLを実行するとメルカリアプリが起動します。【2：APP】の場合、レスポンスの【決済開始URL】にメルカリアプリを設定しますので、ご提供のアプリ内で起動処理を記述してください。注意）【1：WEB】については環境によってメルカリアプリの起動ができない可能性があります。
subscriptionType		必須半角英字10桁サブスクリプションタイプ下記を設定します。 REGISTER：都度決済+利用承諾をする
subscriptionName		必須全半角20桁サブスクリプション名称提供するサービス名を設定します。 ※メルカリアプリ上に表示されます
subscriptionDescription		必須全半角120桁サブスクリプション説明提供するサービスの説明を設定します。 ※メルカリアプリ上に表示されます

URL

/payment/ExecTranMerpay.json

リクエストパラメータ

{
    "shopID":"tshop11223344",
    "shopPass":"PASSWORD",
    "accessID":"a6a6b0061347e90cdef806b39bd28705",
    "accessPass":"5e0e54b892e14ed03e8cf807a6053813",
    "orderID":"ORDER0000001",
    "items":[
        {
            "name":"Tシャツ",
            "description":"テスト出品です",
            "imageUrls":[
                "https://example.com/images/item1.jpg",
                "https://example.com/images/item2.jpg",
                "https://example.com/images/item3.jpg"
            ],
            "category":"メンズ",
            "size":"M",
            "brand":"テストブランド",
            "color":"Black",
            "listPrice":"1200",
            "unitPrice":"1000",
            "quantity":"1",
            "itemCode":"32882558-1c19-4329-afa3-6a5a8fce8e92",
            "janCode":"1234567890123",
            "categoryId":"1010"
        },
        {
            "categoryId":"1011"
        }
    ],
    "retURL":"https://example.com/receive",
    "subscriptionType":"REGISTER",
    "subscriptionName":"サブスクリプション名称",
    "subscriptionDescription":"サブスクリプション説明"
}

レスポンス

正常

AccessID	accessID	半角英数32桁固定取引ID 【決済実行】呼出時に指定した値を返却します。【決済実行】の【ユーザー端末情報】に【1：WEB】を指定した場合、必須となります。
Token	token	半角英数256桁固定トークン取引IDのハッシュ値を返却します。【決済実行】の【ユーザー端末情報】に【1：WEB】を指定した場合に返却します。
StartURL	startURL	必須半角英数記号256桁支払手続き開始IFのURL 支払手続き開始IFのURLを返却します。【決済実行】で指定した【ユーザー端末情報】によって返却する値が異なります。【1：WEB】当サービスの【決済開始】URLを返却します。【2：APP】メルカリアプリを起動するためのURLを返却します。ご利用にはご提供アプリ内で起動処理の記述が必要になります。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "accessID": "84636abd0bb03500ffce1e1a78deb1b2",
    "token": "107c44550ac7f47cbc6dbef22c4c27fd",
    "startURL": "https://x01.mul-pay.jp/payment/MerpayStart.idPass"
}

レスポンスパラメータ：正常系

AccessID=84636abd0bb03500ffce1e1a78deb1b2&Token=107c44550ac7f47cbc6dbef22c4c27fd&StartURL=https://x01.mul-pay.jp/payment/MerpayStart.idPass

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

MerpayStart 支払手続き開始IFの呼び出し

決済実行の【ユーザー端末情報】に「1：WEB（デフォルト）」を指定した場合のみ、ご確認ください。
メルペイにおいて、お客様をメルカリアプリへ遷移させる必要があります。
当サービスのリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。
※取引が特定できない場合、すでに支払いを済ませている場合等は、エラー画面を表示します。

リクエスト

AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
Token		必須半角英数256桁固定トークン【決済実行】で発行された値を設定します。

URL

/payment/MerpayStart.idPass

リダイレクトページサンプル


<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
    <style> body {-webkit-text-size-adjust: 100%;} </style>
</head>
<body OnLoad='OnLoadEvent();'>
<form name="MerpayStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
        <br>
        <br>
        <div style="text-align:center">
            <h2>メルペイの決済画面へ遷移します。</h2>
            <input type="submit" value="続行">
        </div>
    </noscript>
    <input type="hidden" name="AccessID" value="{AccessID}">
    <input type="hidden" name="Token" value="{Token}">
</form>
<script>
<!--
function OnLoadEvent() {
document.MerpayStartCall.submit();
}
//-->
</script>
</body>
</html>

リダイレクト後、お客様はメルカリアプリへ遷移します。

税送料算出

当サービスは、【取引登録】の【税送料算出方法】で「1：後から算出」を選択した場合に配送先情報を通知します。
配送先情報を元に算出した税送料を返却してください。
【取引登録】の【税送料】で指定した値は上書きされます。

End Point	【決済実行】の【税送料算出URL】で指定したURL
Request header	Content-Type: application/json;charset=UTF-8
Method	POST
Response header	Content-Type: application/json;charset=UTF-8
Status Code	200：常に200を返却

リクエスト

shopID		必須半角英数13桁ショップID
orderID		必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
area		必須配送先エリア
	zipCode1	必須半角数字10桁郵便番号1 郵便番号（ハイフン前）
	zipCode2	必須半角数字10桁郵便番号2 郵便番号（ハイフン後）
	prefecture	必須全半角100桁都道府県名
	city	必須全半角100桁市区町村名
checkString		必須半角英数字100桁改ざんチェック文字列以下の情報を連結し、MD5ハッシュした値を返却します。・ショップID ・オーダーID ・郵便番号1 ・郵便番号2 ・都道府県名・市区町村名

リクエストパラメータ

{
    "shopID":"tshop11223344",
    "orderID":"ORDER0000001",
    "area":{
        "zipCode1":"106",
        "zipCode2":"6143",
        "prefecture":"東京都",
        "city":"港区"
    },
    "checkString":"65ccb518964f337644c82e7d1781781f"
}

レスポンス

正常

tax		必須半角数字7桁税送料配送先情報を元に算出した税送料を返却してください。算出不可の場合、-1を返却してください。

レスポンスパラメータ：決済成功時

{
    "tax":"150"
}

決済結果受信

当サービスは、お客様が支払操作を完了または中止した際に、決済実行時に指定された決済結果戻しURLに結果を通知します。
この決済結果は、メルカリアプリの決済完了画面からブラウザ経由で連携されるため、ユーザの操作方法によっては支払操作が完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面または結果通知にてご確認ください。
また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス

正常

ShopID		必須半角英数13桁ショップID
OrderID		必須半角英数記号27桁オーダーID
Status		必須現状態 AUTH：仮売上 CAPTURE：即時売上 PAYFAIL：決済失敗
TranDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
CheckString		必須半角英数32桁改ざんチェック文字列以下の情報を連結し、SHA256ハッシュした値を返却します。・ショップID ・オーダーID ・現状態・処理日時・ショップパスワード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

出力パラメータサンプル

【決済実行】の【ユーザー端末情報】に【2：APP】を指定した場合、メルカリアプリから直接決済結果戻しURLに結果が返却されます。
加盟店様が指定した決済結果戻しURL（example://pay/receive?Xxx=xxx）には上述したURLパラメータの他、メルペイによって【transaction_id】が自動で追加されます。
これらと重複するURLパラメータは指定しないでください。

決済成功時

example://pay/receive?Xxx=xxx&ShopID=tshop11223344&OrderID=ORDER0000001&Status=AUTH&TranDate=20191216090000&CheckString=1e8b27418fcdc9c0214a035cd81c1749&transaction_id=87bc26b6-ecce-4340-a531-5bfd691de8eb

決済失敗時

example://pay/receive?Xxx=xxx&ShopID=tshop11223344&OrderID=ORDER0000001&Status=PAYFAIL&TranDate=20191216090000&CheckString=b221034dc5015da574dca0f6b710055f&ErrCode=MP1&ErrInfo=MP1000001&transaction_id=87bc26b6-ecce-4340-a531-5bfd691de8eb

MerpaySales 実売上

仮売上の決済に対して実売上を行います。
仮売上の決済の取引ID・取引パスワードを指定すると、売上の確定処理(以下、実売上)が可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
Amount	amount	必須半角数字7桁利用金額税送料を指定した場合は、合計利用金額が売上確定となります。仮売上時の合計利用金額を超える金額は指定できません。仮売上時の合計利用金額に満たない金額を指定した場合、差額はキャンセルされます。（一部実売上の例）　仮売上時の利用金額 = 1000円　指定する利用金額＝ 800円上記の条件で実売上を行った結果　売上金額 = 800円　キャンセル金額 = 200円
Tax	tax	半角数字7桁税送料

URL

/payment/MerpaySales.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000"
}

URL

/payment/MerpaySales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

OrderID		orderID		必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status		status		必須現状態 SALES：実売上

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "SALES"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

MerpayCancelReturn キャンセル

仮売上及び実売上取引の取引ID・取引パスワードを指定すると、以前に実施した決済内容をキャンセルすることが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
Amount	amount	必須半角数字7桁利用金額仮売上および実売上時の合計利用金額と一致する金額を設定するとキャンセルします。（一部キャンセルを行いたい場合）キャンセルしたい金額を設定します。設定した金額がお客様に返金され、差額は実売上の状態のままとなります。例）　実売上時の利用金額 = 1000円　設定した利用金額＝ 200円上記の条件でキャンセルを行った結果　売上金額 = 800円　キャンセル金額 = 200円
Tax	tax	半角数字7桁税送料

URL

/payment/MerpayCancelReturn.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "500"
}

URL

/payment/MerpayCancelReturn.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=500

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態　CANCEL：キャンセル　RETURN：返金　SALES：実売上（※）　CAPTURE：即時売上（※） ※一部キャンセルの場合に返却されます。
InquiryCode	inquiryCode	必須半角英数20桁メルペイ取引番号

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
"orderID":"ORDER0000001",
"status":"RETURN",
"inquiryCode":"012345678901"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=RETURN&InquiryCode=0123456789

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

MerpayAcceptEnd 利用承諾終了

指定したサブスクリプションIDの利用を終了することが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
SubscriptionId	subscriptionId	必須半角英数50桁サブスクリプションID 終了させたい利用承諾のサブスクリプションＩＤを設定します。

URL

/payment/MerpayAcceptEnd.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "subscriptionId": "87bc26b6-ecce-4340-a531-5bfd691de8eb"
}

URL

/payment/MerpayAcceptEnd.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&SubscriptionId=87bc26b6-ecce-4340-a531-5bfd691de8eb

レスポンス

正常

SubscriptionId		subscriptionId		必須半角英数50桁サブスクリプションID
Status		status		必須半角英字3桁現状態 END：終了

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "subscriptionId": "87bc26b6-ecce-4340-a531-5bfd691de8eb",
  "status": "END"
}

レスポンスパラメータ：正常系

SubscriptionId=87bc26b6-ecce-4340-a531-5bfd691de8eb&Status=END

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
PayType		必須半角数字2桁決済方法 43：メルペイ

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=43

レスポンス

正常

Status		必須現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 CANCEL：キャンセル RETURN：返金 PAYFAIL：決済失敗 EXPIRED：期限切れ
ProcessDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd		必須処理区分 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 CANCEL：キャンセル RETURN：返金 EXPIRE：期限切れ END：利用終了
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
Amount		必須半角数字7桁利用金額決済した金額を返却します。
Tax		必須半角数字7桁税送料
ClientField1		必須全半角100バイト加盟店自由項目1
ClientField2		必須全半角100バイト加盟店自由項目2
ClientField3		必須全半角100バイト加盟店自由項目3
PayType		必須半角数字2桁決済方法 43：メルペイ
MerpayCancelAmount		必須半角数字7桁キャンセル金額該当取引について発生したキャンセル・返金額を返却します。
MerpayCancelTax		必須半角数字7桁キャンセル税送料金額該当取引について発生したキャンセル・返金税送料を返却します。
MerpayInquiryCode		半角英数20桁メルペイ取引番号お客様がメルカリアプリで残高履歴等から確認できる取引番号です。現状態がAUTH/SALES/CAPTURE/CANCEL/RETURNのいずれかの場合返却します。
MerpaySubscriptionType		必須サブスクリプションタイプ REGISTER：決済+利用承諾
MerpaySubscriptionId		必須半角英数50桁サブスクリプションＩＤメルペイが発行したサブスクリプションＩＤを返却します。
MerpaySubscriptionCurrentStatus		必須サブスクリプション現状態利用承諾の現状態を返却します。 REQSUCCESS：要求成功 REGISTER：利用承諾 END：利用終了 PAYFAIL：決済失敗 EXPIRED：期限切れ
MerpaySubscriptionStartDate		必須半角数字14桁サブスクリプション利用承諾日時 yyyyMMddHHmmss書式
MerpaySubscriptionEndDate		半角数字14桁サブスクリプション利用終了日時 yyyyMMddHHmmss書式
MerpaySettlementSubscriptionId		半角英数50桁随時決済用サブスクリプションID nullで返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=AUTH&ProcessDate=20191216090000&JobCd=AUTH&AccessID=67ed6da3551771c9f592cd6f7a19a90c&AccessPass=0695cc5eb676f9e11ab6e432f3747941&Amount=10000&Tax=1000&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=43&MerpayCancelAmount=500&MerpayCancelTax=50&MerpayInquiryCode=123456789012&MerpaySubscriptionType=REGISTER&MerpaySubscriptionId=52c09ac5-4188-4197-b6b0-96bac5f992ff&MerpaySubscriptionCurrentStatus=REGISTER&MerpaySubscriptionStartDate=20200813191415&MerpaySubscriptionEndDate=&MerpaySettlementSubscriptionId=

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

MerpaySearchPersonalData 個人情報参照

対象取引の配送先情報を取得します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。

URL

/payment/MerpaySearchPersonalData.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001"
}

URL

/payment/MerpaySearchPersonalData.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001

レスポンス

正常

BuyerNickname	buyerNickname	販売元ニックネーム今後の機能拡張のための項目です。現在は空文字が返却されます。
BuyerTel	buyerTel	販売元電話番号今後の機能拡張のための項目です。現在は空文字が返却されます。
BuyerMail	buyerMail	販売元メールアドレス今後の機能拡張のための項目です。現在は空文字が返却されます。
DeliveryFamilyName	deliveryFamilyName	全半角100桁配送先姓
DeliveryFirstName	deliveryFirstName	全半角100桁配送先名
DeliveryFamilyNameKana	deliveryFamilyNameKana	全半角100桁配送先姓（カナ）
DeliveryFirstNameKana	deliveryFirstNameKana	全半角100桁配送先名（カナ）
DeliveryTel	deliveryTel	全半角40桁配送先電話番号
DeleveryZipCode	deleveryZipCode	全半角41桁配送先郵便番号
DeliveryPrefecture	deliveryPrefecture	全半角100桁配送先都道府県
DeliveryCity	deliveryCity	全半角100桁配送先市区町村
DeliveryAddress1	deliveryAddress1	全半角200桁配送先住所1
DeliveryAddress2	deliveryAddress2	全半角200桁配送先住所2

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系（決済完了）

{
  "buyerNickname": "",
  "buyerTel": "",
  "buyerMail": "",
  "deliveryFamilyName": "山田",
  "deliveryFirstName": "太郎",
  "deliveryFamilyNameKana": "ヤマダ",
  "deliveryFirstNameKana": "タロウ",
  "deliveryTel": "09012345678",
  "deleveryZipCode": "106-6143",
  "deliveryPrefecture": "東京都",
  "deliveryCity": "港区",
  "deliveryAddress1": "六本木6-10-1",
  "deliveryAddress2": "六本木ヒルズ森タワー"
}

レスポンスパラメータ：正常系（決済処理中/決済失敗）

{
  "deleveryZipCode": "106-6143",
  "deliveryPrefecture": "東京都",
  "deliveryCity": "港区"
}

レスポンスパラメータ：正常系

BuyerNickname=&BuyerTel=&BuyerMail=&DeliveryFamilyName=山田&DeliveryFirstName=太郎&DeliveryFamilyNameKana=ヤマダ&DeliveryFirstNameKana=タロウ&DeliveryTel=09012345678&DeleveryZipCode=106-6143&DeliveryPrefecture=東京都&DeliveryCity=港区&DeliveryAddress1=六本木6-10-1&DeliveryAddress2=六本木ヒルズ森タワー

レスポンスパラメータ：正常系（決済処理中/決済失敗）

DeleveryZipCode=106-6143&DeliveryPrefecture=東京都&DeliveryCity=港区

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

メルペイ